ly.img:engine/ly.img.engine/HorizontalAlignment

HorizontalAlignment

enum HorizontalAlignment : Enum<HorizontalAlignment>

The horizontal alignment of a text block.

The engine reads these values by name, not by position. The order here is the display order, and it does not match the engine's numeric order.

Entries

Left

Align text to the left.

Center

Align text to the center.

Right

Align text to the right.

Justify

The gaps between words are widened until each line fills the block. The last line of a paragraph keeps its natural width and aligns like Auto. A line with no gap to widen, such as CJK text, keeps its natural width too.

Auto

Match alignment to the text direction.

Properties

entries

val entries: EnumEntries<HorizontalAlignment>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): HorizontalAlignment

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<HorizontalAlignment>

Returns an array containing the constants of this enum type, in the order they're declared.